Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Function |locate

std/secret::|locate

Usage

|locate<T>(locator, name, transmission, plain_reveal)

Generics

◻ T (any)

Parameters

↳ locator: string
↳ name: string
↳ transmission: string
↳ plain_reveal: bool

Return

↴ Option<Secret<T>>

Secret resolved from locator when revealed, with an explicit policy.

  • locator: <scheme>:<path>, such as env:MELODIUM_SECRET_NAME, file:PATH, or a scheme registered by a source model.
  • transmission: where the secret may go when the program is distributed, local (never leaves this engine), reference (only the locator is sent), or value (the value is sent).
  • plain_reveal: whether the plain reveal treatment may reveal it, never for env: and file: secrets.

Gives none if locator or transmission are not valid.